FMS Explorer Close Period Control

Using the Close Period Control

Note: This functionality is only available in systems licensed for FULL mode.

Close Period icon Use the Close Period control to view and track closed periods, and to execute Close Period commands to close (or test close) records for a specified period, for a single or multiple selected Nodes. You can create up to eight instances of this control. See Close Period in the FMS Commands section for more information about the command.

Available Node categories for this control include

Group - (general group and station group Nodes)
Device - (both gas and liquid device Nodes)
Gas Device - (gas meter or station meter Nodes)
Liquid Device - (liquid device Nodes with periodic history support)
Station - (station group and station meter Nodes) Group selections are resolved to their component Node entries in the control.

To select multiple Nodes from the filtered Node Chooser results, use the Apply changes option. See Using the Node Chooser Control for more information about using Apply changes to display multiple Nodes.

Note: Although a General Group Node can be selected in the Node Chooser of the Close Period control, and a Close Period command can be executed against it, you cannot run a Close Period command against General Group Nodes in other parts of FMS Explorer. Outside of the Close Period control, run the command against each desired member Node of the target group.

All selections applied from the Node chooser are resolved down to their member Node entries, which are displayed in the control data grid. Each row of the data grid represents a group or station or device Node. Each column represents a data field. Above the data grid is a control toolbar including a Close through (C) date selector, and buttons to Test Test and Close Period for the selected records. Use the context menu to access additional options to customize the data view directly from the grid. See Testing and Closing Periods for more information about using these elements.

Closed periods are always in Contract time (C), through midnight of the specified date. The record for each Node contains a timestamp of the end of the currently closed period. The closed period can only roll forward, and must be consecutive, therefore the start of a closed period is determined by the end of the previously closed period, and you only need enter a Close through (C) date to define the period. If a Node has never been closed previously, the start of the closed period is the timestamp when the Node first started receiving data.

Note: Records can be identified as closed if their End DateTime value is prior to the Closed timestamp.

To close the period, data within the period must meet the close period criteria as configured in the system options page of the Administrative Options, accessed via the Admin menu. The configured options allow limits or conditions to be placed on closing periods. Possible limits include allowing a period to be closed only if no exceptions (including linked exceptions) exist, only if data meets or exceeds minimum data quality settings, only if no data is missing, and/or only if there are no outstanding PPAs. See the Close period section in Configuring Systems Options for more information.

Validation and recalculation behavior as a result of data changes follows the data change settings configured in the system options page of the Administrative Options, accessed via the Admin menu. Any changes made to a record after the period has been closed may generate a prior period adjustment. See the Data change section in Configuring Systems Options for more information.

You must have proper security authorization to perform these actions. See FMS Security (and CLOSE security event) for information about configuring security access for the Close Period control.

See CygNet FMS Close Period Control for more information about configuring this control in CygNet Studio.

See FMS Explorer User Interface for more information about the FMS Explorer user interface features.

Viewing Close Period Data

Use the Close Period control Chooser pane to filter the Nodes to show in the grid. The pane can optionally be displayed or pinned to the left side. (No Options pane is necessary for this control.)

Chooser Pane

In the embedded Node Chooser for the Close Period control, select the Nodes you want to view data for from a selected Node category. Further filter the Nodes by name, description, or ID as desired. See Using the Node Chooser Control for more information.

Note: Selected Nodes will be resolved to their station entries (station meters and physical station groups) for display in the control.

Columns

Close Period data grid columns are fixed in position but can be adjusted for viewing in the following ways.

Click on a column header to sort the data grid view based on that field, in either ascending or descending order.
Hover over a fixed column edge to display an icon to reset column width. Drag the column to the desired width.

Columns in the grid represent the following data fields.

Field	Description
Node Name	The selected Node name Click on the column header to sort the displayed data (in ascending or descending order) based on Node Name.
Node Description	The selected Node description Click on the column header to sort the displayed data (in ascending or descending order) based on Node Description.
Closed Through (C)	The "closed through" date for the selected Node Click on the column header to sort the displayed data (in ascending or descending order) based on Closed Through (C) date. Note: Closed periods are always in Contract day (C) through midnight for the selected date.
Result	The test result for the selected Node name Click on the column header to sort the displayed data (in ascending or descending order) based on test close Result.

Managing Close Period Data

Toolbar

Use the Close Period control toolbar to access options to manage the data you are viewing. See Menus and Toolbars for more information.

Close Period control toolbar

The following options appear on the toolbar; unavailable buttons appear dimmed.

Option	Description
	Click to Refresh the control view. See Refresh Button for more information.
	[The Save button is not available on this control.]
	[The Cancel button is not available on this control.]
	Click to Open and view the control as a .csv file.
	[The Print button is not available on this control.]
	Click Export to access the Save As dialog box, to export the contents of the control to a .csv file. Type a File name into the text box, select a file directory location, and then click Save to export the file.
	Click to Test close the selected Node records prior to committing a close period and access the FMS Command: Close Period dialog box. Alternatively, use the context menu Test option. Note: Test closing a period does not alter the database. Test results for the selected Node(s) are listed in table form in the top pane of the dialog box. Click on any data row to display detailed results in the Command Results (bottom) pane. Note: Once the command dialog box is closed, results can be viewed in the Command Log. See Viewing Command Logs for more information. See Close Period for more information about the command that is triggered by this action. See Testing and Closing Periods for more information about the process.
	Click to Close Period for the selected Node record(s) and access the FMS Command: Close Period dialog box. Alternatively, use the context menu Close period option. Close period results for the selected Node(s) are listed in table form in the top pane of the dialog box. Click on any data row to display detailed results in the Command Results (bottom) pane. Note: Once the command dialog box is closed, results can be viewed in the Command Log. See Viewing Command Logs for more information. See Close Period for more information about the command that is triggered by this action. See Testing and Closing Periods for more information about the process.
Close through (C):	Select the contract day (C) through which to close period for the selected Node(s). Note: You can close periods up until two days ago (current date minus two contract days). Attempts to close through yesterday, today, or in the future will fail. This can be done in the following ways. Click in the text box to select the date field desired, then type the month (type 1 letter to access first-letter matching), day (type 1 or 2 digits), or year (type 2 digits). Click the single down arrow to display the calendar and navigate to the desired Close Through (Contract Day) date. Click to select the date. Click to select the part of the Close Through (Contract Day) date you wish to change (e.g. month, day, or year) and navigate with the paired up/down arrows to change it.

Context Menu

Use the context menu to access options to set the Session Node, or to test or close periods for selected Nodes directly from the data grid.

Right-click on the selected Node name row(s) to access the following options.

Option	Description
Test	Click to Test close records prior to committing a close period and access the FMS Command: Close Period dialog box. Alternatively, use the toolbar Test option. Note: Test closing a period does not alter the database. Test results for the selected Node(s) are listed in table form in the top pane of the dialog box. Click on any data row to display detailed results in the Command Results (bottom) pane. Note: Once the command dialog box is closed, results can be viewed in the Command Log. See Viewing Command Logs for more information. See Testing and Closing Periods for more information.
Close period	Click to Close period for the selected Node(s) and access the FMS Command: Close Period dialog box. Alternatively, use the toolbar Close period option. Close period results for the selected Node(s) are listed in table form in the top pane of the dialog box. Click on any data row to display detailed results in the Command Results (bottom) pane. Note: Once the command dialog box is closed, results can be viewed in the Command Log. See Viewing Command Logs for more information. See Testing and Closing Periods for more information.
Select all	Click to select all available rows of data in order to Test or Close period for all of the displayed Nodes at once.
Set as Session Node	Click Set as Session Node to set the selected Node as the Session Node. Alternatively, press Ctrl+Shift+S to set the Session Node using a keyboard shortcut. See Session Node and Using Keyboard Shortcuts for more information.

Testing and Closing Periods